<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../luadoc.css" type="text/css" />
	<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>

<body>
<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->

<div id="main">

<div id="navigation">


<h1>LuaDoc</h1>
<ul>
	
	<li><a href="../index.html">Index</a></li>
	
</ul>


<!-- Module list -->

<h1>Modules</h1>
<ul>

	<li><strong>gwee</strong></li>
	
</ul>



<!-- File list -->






</div><!-- id="navigation" -->

<div id="content">

<h1>Module <code>gwee</code></h1>

<p></p>





<h2>Functions</h2>
<table class="function_list">

	<tr>
	<td class="name" nowrap><a href="#Box:initialize">Box:initialize</a>&nbsp;(x, y, w, h)</td>
	<td class="summary">Box constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Button:initialize">Button:initialize</a>&nbsp;(callback, label)</td>
	<td class="summary">Button constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#CheckBox:initialize">CheckBox:initialize</a>&nbsp;(label)</td>
	<td class="summary">CheckBox constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:add">Group:add</a>&nbsp;(widget)</td>
	<td class="summary">Add a widget to a group.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:draw">Group:draw</a>&nbsp;()</td>
	<td class="summary">love2d callback.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:initialize">Group:initialize</a>&nbsp;(box, layout, label, skin)</td>
	<td class="summary">Group constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:keypressed">Group:keypressed</a>&nbsp;(key, unicode)</td>
	<td class="summary">love2d callback.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:mousepressed">Group:mousepressed</a>&nbsp;(x, y, button)</td>
	<td class="summary">love2d callback.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:mousereleased">Group:mousereleased</a>&nbsp;(x, y, button)</td>
	<td class="summary">love2d callback.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group:update">Group:update</a>&nbsp;(dt)</td>
	<td class="summary">love2d callback.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Slider:initialize">Slider:initialize</a>&nbsp;(min, max, label)</td>
	<td class="summary">Slider constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#TextField:initialize">TextField:initialize</a>&nbsp;(label)</td>
	<td class="summary">TextField constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#VerticalLayout:initialize">VerticalLayout:initialize</a>&nbsp;(spacing)</td>
	<td class="summary">VerticalLayout constructor.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#draw">draw</a>&nbsp;()</td>
	<td class="summary">love2d accelerator.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#keypressed">keypressed</a>&nbsp;(key, unicode)</td>
	<td class="summary">love2d accelerator.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#loadSkin">loadSkin</a>&nbsp;(skinName)</td>
	<td class="summary">Load a skin from a directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#mousepressed">mousepressed</a>&nbsp;(x, y, button)</td>
	<td class="summary">love2d accelerator.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#mousereleased">mousereleased</a>&nbsp;(x, y, button)</td>
	<td class="summary">love2d accelerator.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#update">update</a>&nbsp;(dt)</td>
	<td class="summary">love2d accelerator.</td>
	</tr>

</table>




<h2>Tables</h2>
<table class="table_list">

	<tr>
	<td class="name" nowrap><a href="#Box">Box</a></td>
	<td class="summary">A bounding box.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Button">Button</a></td>
	<td class="summary">A clickable button.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#CheckBox">CheckBox</a></td>
	<td class="summary">A check box.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Group">Group</a></td>
	<td class="summary">A group of widgets.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Slider">Slider</a></td>
	<td class="summary">A value slider.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#TextField">TextField</a></td>
	<td class="summary">A one-line text field.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#VerticalLayout">VerticalLayout</a></td>
	<td class="summary">Stacks widgets vertically.</td>
	</tr>

</table>



<br/>
<br/>



<h2><a name="functions"></a>Functions</h2>
<dl class="function">



<dt><a name="Box:initialize"></a><strong>Box:initialize</strong>&nbsp;(x, y, w, h)</dt>
<dd>
Box constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: The horizontal position.
	</li>
	
	<li>
	  y: The vertical position.
	</li>
	
	<li>
	  w: The width.
	</li>
	
	<li>
	  h: The height.
	</li>
	
</ul>








</dd>




<dt><a name="Button:initialize"></a><strong>Button:initialize</strong>&nbsp;(callback, label)</dt>
<dd>
Button constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  callback: The callback function to invoke when clicked.
	</li>
	
	<li>
	  label: The text label to place on the button.
	</li>
	
</ul>








</dd>




<dt><a name="CheckBox:initialize"></a><strong>CheckBox:initialize</strong>&nbsp;(label)</dt>
<dd>
CheckBox constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  label: The label to place beside the check box.
	</li>
	
</ul>








</dd>




<dt><a name="Group:add"></a><strong>Group:add</strong>&nbsp;(widget)</dt>
<dd>
Add a widget to a group.


<h3>Parameters</h3>
<ul>
	
	<li>
	  widget: An instance of one of the widget classes.
	</li>
	
</ul>






<h3>Return value:</h3>
The widget passed in. Convenience.



</dd>




<dt><a name="Group:draw"></a><strong>Group:draw</strong>&nbsp;()</dt>
<dd>
love2d callback.









</dd>




<dt><a name="Group:initialize"></a><strong>Group:initialize</strong>&nbsp;(box, layout, label, skin)</dt>
<dd>
Group constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  box: The bounding box of the group.
	</li>
	
	<li>
	  layout: The layout to use.
	</li>
	
	<li>
	  label: The header to display above the widgets.
	</li>
	
	<li>
	  skin: The skin customizations to use (optional).
	</li>
	
</ul>








</dd>




<dt><a name="Group:keypressed"></a><strong>Group:keypressed</strong>&nbsp;(key, unicode)</dt>
<dd>
love2d callback.


<h3>Parameters</h3>
<ul>
	
	<li>
	  key: As passed to love.keypressed().
	</li>
	
	<li>
	  unicode: As passed to love.keypressed().
	</li>
	
</ul>








</dd>




<dt><a name="Group:mousepressed"></a><strong>Group:mousepressed</strong>&nbsp;(x, y, button)</dt>
<dd>
love2d callback.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: As passed to love.mousepressed().
	</li>
	
	<li>
	  y: As passed to love.mousepressed().
	</li>
	
	<li>
	  button: As passed to love.mousepressed().
	</li>
	
</ul>








</dd>




<dt><a name="Group:mousereleased"></a><strong>Group:mousereleased</strong>&nbsp;(x, y, button)</dt>
<dd>
love2d callback.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: As passed to love.mousereleased().
	</li>
	
	<li>
	  y: As passed to love.mousereleased().
	</li>
	
	<li>
	  button: As passed to love.mousereleased().
	</li>
	
</ul>








</dd>




<dt><a name="Group:update"></a><strong>Group:update</strong>&nbsp;(dt)</dt>
<dd>
love2d callback.


<h3>Parameters</h3>
<ul>
	
	<li>
	  dt: As passed to love.update().
	</li>
	
</ul>








</dd>




<dt><a name="Slider:initialize"></a><strong>Slider:initialize</strong>&nbsp;(min, max, label)</dt>
<dd>
Slider constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  min: The minimum value allowed by the slider.
	</li>
	
	<li>
	  max: The maximum value allowed by the slider.
	</li>
	
	<li>
	  label: The label to place beside the slider.
	</li>
	
</ul>








</dd>




<dt><a name="TextField:initialize"></a><strong>TextField:initialize</strong>&nbsp;(label)</dt>
<dd>
TextField constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  label: The label to place beside the input box.
	</li>
	
</ul>








</dd>




<dt><a name="VerticalLayout:initialize"></a><strong>VerticalLayout:initialize</strong>&nbsp;(spacing)</dt>
<dd>
VerticalLayout constructor.


<h3>Parameters</h3>
<ul>
	
	<li>
	  spacing: The amount of space between each widget.
	</li>
	
</ul>








</dd>




<dt><a name="draw"></a><strong>draw</strong>&nbsp;()</dt>
<dd>
love2d accelerator. Invokes draw() on all enabled Groups.









</dd>




<dt><a name="keypressed"></a><strong>keypressed</strong>&nbsp;(key, unicode)</dt>
<dd>
love2d accelerator. Invokes keypressed() on all enabled Groups.


<h3>Parameters</h3>
<ul>
	
	<li>
	  key: As passed to love.keypressed().
	</li>
	
	<li>
	  unicode: As passed to love.keypressed().
	</li>
	
</ul>








</dd>




<dt><a name="loadSkin"></a><strong>loadSkin</strong>&nbsp;(skinName)</dt>
<dd>
Load a skin from a directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  skinName: The name of the directory to look in.
	</li>
	
</ul>






<h3>Return value:</h3>
The skin, to be passed to Group:initialize().



</dd>




<dt><a name="mousepressed"></a><strong>mousepressed</strong>&nbsp;(x, y, button)</dt>
<dd>
love2d accelerator. Invokes mousepressed() on all enabled Groups.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: As passed to love.mousepressed().
	</li>
	
	<li>
	  y: As passed to love.mousepressed().
	</li>
	
	<li>
	  button: As passed to love.mousepressed().
	</li>
	
</ul>








</dd>




<dt><a name="mousereleased"></a><strong>mousereleased</strong>&nbsp;(x, y, button)</dt>
<dd>
love2d accelerator. Invokes mousereleased() on all enabled Groups.


<h3>Parameters</h3>
<ul>
	
	<li>
	  x: As passed to love.mousepressed().
	</li>
	
	<li>
	  y: As passed to love.mousepressed().
	</li>
	
	<li>
	  button: As passed to love.mousepressed().
	</li>
	
</ul>








</dd>




<dt><a name="update"></a><strong>update</strong>&nbsp;(dt)</dt>
<dd>
love2d accelerator. Invokes update() on all enabled Groups.


<h3>Parameters</h3>
<ul>
	
	<li>
	  dt: As passed to love.update().
	</li>
	
</ul>








</dd>


</dl>




<h2><a name="tables"></a>Tables</h2>
<dl class="table">

<dt><a name="Box"></a><strong>Box</strong></dt>
<dd>A bounding box. Used to specify areas on the screen for layouts.



</dd>


<dt><a name="Button"></a><strong>Button</strong></dt>
<dd>A clickable button. Invokes a callback function when clicked.



</dd>


<dt><a name="CheckBox"></a><strong>CheckBox</strong></dt>
<dd>A check box. Toggle on and off with mouse clicks.


<em>Fields</em>
<ul>
	
	<li>
	  checked: Whether the box is currently checked.
	</li>
	
</ul>


</dd>


<dt><a name="Group"></a><strong>Group</strong></dt>
<dd>A group of widgets. Groups are meant to hold a set of widgets with a similar purpose. They delegate all love callbacks to their child widgets (which can include other groups), their child widgets are automatically arranged, they can be skinned, and place a label above their bounding box.


<em>Fields</em>
<ul>
	
	<li>
	  enabled: Controls whether love2d callback accelerators will affect this Group.
	</li>
	
</ul>


</dd>


<dt><a name="Slider"></a><strong>Slider</strong></dt>
<dd>A value slider. Drag the slider along the bar to change the value.


<em>Fields</em>
<ul>
	
	<li>
	  value: The current value on the slider.
	</li>
	
</ul>


</dd>


<dt><a name="TextField"></a><strong>TextField</strong></dt>
<dd>A one-line text field. Supports the following special keys: backspace, delete, home, end, left, right


<em>Fields</em>
<ul>
	
	<li>
	  text: The text currently in the buffer.
	</li>
	
</ul>


</dd>


<dt><a name="VerticalLayout"></a><strong>VerticalLayout</strong></dt>
<dd>Stacks widgets vertically.



</dd>


</dl>



</div> <!-- id="content" -->

</div> <!-- id="main" -->

<div id="about">
	<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->	
</body>
</html>
